Refactor (packages/web/src/i18n/locales.ts): Function with many returns (count = 7) - #22
Open
hlabda wants to merge 2 commits into
Open
Refactor (packages/web/src/i18n/locales.ts): Function with many returns (count = 7)#22hlabda wants to merge 2 commits into
hlabda wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
P1B: Starter Task: Refactoring PR
Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.
1. Issue
Link to the associated GitHub issue:
#4
Full path to the refactored file:
packages/web/src/i18n/locales.ts
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
I think that this file handles locales and converts different language into the locales supported by the website
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
I refactored the matchLocale function, which matches an input locale to one of the supported locales.
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
Function with many returns (count = 7): matchLocale
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
Having many return statements made the function harder to read and follow.
What changes did you make to resolve the issue?
I used a result variable instead of returning many times, then returned result once at the end.
How do your changes improve maintainability? Did you consider alternatives?
The function is easier to understand because it now uses one result variable and one final return instead of returning from many different places. I also considered keeping an early return, but using one final return directly fixes the Qlty issue.
3. Validation
How did you validate that the change is correct?
I added tests for matchLocale (its a file called locales.test.ts) to check different locale inputs and invalid inputs. All 8 tests passed, and locales.ts had 93.14% line coverage, including the part I changed.
Attach a screenshot of the test coverage showing the lines were executed by the tests.
Attach a screenshot showing the tests that cover the change passing during CI
Attach a screenshot of
qlty smells --no-snippets <full/path/to/file.ts>showing fewer reported issues after the changes.Before:
After:
